Массовое создание автомобилей
Запрос позволяет создать сразу несколько автомобилей, указав их данные в теле запроса.
Синтаксис запроса
POST https://b2b-api.go.yandex.ru/integration/2.0/vehicles/bulk-create
Заголовки запроса
Authorization: Bearer <OAuth-токен>
Процесс получения токена описан в разделе Начало работы.
X-YaTaxi-Selected-Corp-Client-Id— ID клиента из Личного кабинета. Обязателен, если по токену доступно несколько клиентов.
X-Idempotency-Token— токен идемпотентности, строка формата UUID. Одному токену идемпотентности соответствует один заказ, для нового заказа нужно сгенерировать новый токен. Обязательный заголовок.
Тело запроса
Данные передаются в формате JSON:
| Поле | Описание | Формат | Обязательность |
|---|---|---|---|
vehicles |
Массив описаний автомобилей vehicles. | Массив | Да |
Структура элемента массива vehicles:
| Поле | Описание | Формат | Обязательность |
|---|---|---|---|
license_plate |
Номер автомобиля. | Строка | Да |
model |
Модель автомобиля. | Строка | Да |
limit_id |
Идентификатор лимита на заправку. | Строка | Да |
access_type |
Тип доступа. Возможные значения: anyone или custom. |
Строка | Да |
access |
Массив прав доступа access. | Массив | Нет |
Структура элемента массива access:
| Поле | Описание | Формат | Обязательность |
|---|---|---|---|
entity_type |
Тип субъекта доступа. Возможные значения: user, department. |
Строка | Да |
entity_id |
Идентификатор пользователя или отдела. | Строка | Да |
Описание полей ответа
Возвращает список идентификаторов созданных машин.
| Поле | Описание | Формат |
|---|---|---|
items |
Массив объектов с vehicle_id. |
Массив |
vehicle_id |
Уникальный идентификатор машины | Строка |
Пример запроса
POST https://b2b-api.go.yandex.ru/integration/2.0/vehicles/bulk-create
Authorization: Bearer <OAuth-токен>
X-YaTaxi-Selected-Corp-Client-Id: <client-id>
X-Idempotency-Token: <токен>
{
"vehicles": [
{
"license_plate": "Е768КК58",
"model": "Haval-5",
"limit_id": "7715b67....c9b0d4b6",
"access_type": "custom",
"access": [
{
"entity_type": "department",
"entity_id": "6ddfc4...ec77b135f"
}
]
}
]
}
Пример ответа
{
"ids": [
"4cd981dc5....805500202"
]
}
Возможные коды ответа
200— успешно создано400— ошибка валидации параметров404— клиент не найден409— конфликт (например, дубликат номера машины)503— временная ошибка сервера
Была ли статья полезна?
Предыдущая
Следующая